/*
 * Copyright 2007-2008 Brian Cavalier
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package  org.bc.iterate;

import java.util.regex.Pattern;
	
/**
 * Grep is a {@link org.bc.iterate.Test} that matches regular expressions.
 * 
 * @author Brian Cavalier
 * @see Test
 */
public class Grep implements Test<String>{
	private Pattern _pattern;

	/**
	 * Construct a Grep that uses the supplied {@link java.util.regex.Pattern} for matching.
	 *
	 * @param p Pattern to use in matching.
	 */
	public Grep(Pattern p) {
		_pattern = p;
	}

	
	/**
	 * Performs a pattern match against {@code text} .
	 *
	 * @param text {@code String} to match against. 
	 * @return true if resulting {@code String} matches the {@link java.util.regex.Pattern}.
	 */
	public boolean go(String text) {
		return(_pattern.matcher(text).matches());
	}
}
